Carbon


EmptyCollection

Header: Collections.h Carbon status: Supported

Removes every item in a collection.

void EmptyCollection (
    Collection c
);
c

A reference to the collection object you want to empty. The behavior of this function is undefined if you do not provide a reference to a valid collection object.

DISCUSSION

This function removes every item in the collection referenced by the c parameter. This function provides the fastest mechanism for emptying a collection.

To remove all of the items in a collection whose attributes match a specified pattern, use the PurgeCollection function.

To remove all of the items in a collection with a specified collection tag, use the PurgeCollectionTag function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)